Skip to main content
Version: 24.03

Cancel job for requested jobId.

Cancel job for requested jobId.

Path Parameters
  • id uuid required

    Possible values: >= 36 characters and <= 36 characters

    Id of the job.

    Example: 6c311d29-5753-46d4-b32c-19b918ea93b0
Responses

Job with requested jobId canceled.


Schema
  • completedOn date-time
  • createdOn date-time
  • exception object

    Job error details.

  • errorDetail string

    Possible values: <= 4000 characters

    Detailed exception information.

  • exception string

    Possible values: <= 100 characters

    Exception name.

  • exceptionDate date-time

    Datetime error occurs.

  • globalAssetId string

    Possible values: >= 45 characters and <= 45 characters, Value must match regular expression ^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

    Part global unique id in the format urn:uuid:uuid4.

  • id uuid

    Possible values: >= 36 characters and <= 36 characters, Value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i

    Id of the job.

  • lastModifiedOn date-time
  • owner string

    The IRS api consumer.

  • parameter object

    Job parameter of job processing.

  • aspects string
  • bomLifecycle string

    Possible values: [asBuilt, asPlanned, asSpecified]

    The lifecycle context in which the child part was assembled into the parent part.

  • bpn string
  • callbackUrl string
  • collectAspects boolean
  • depth int32

    Possible values: <= 2147483647

  • direction string

    Possible values: [upward, downward]

    Item graph traversal direction.

  • lookupBPNs boolean
  • startedOn date-time
  • state string

    Possible values: [UNSAVED, INITIAL, RUNNING, TRANSFERS_FINISHED, COMPLETED, CANCELED, ERROR]

  • summary object

    Summary of the job with statistics of the job processing.

  • asyncFetchedItems object

    Statistics of job execution.

  • completed int32

    Possible values: <= 2147483647

    Number of completed item transfers.

  • failed int32

    Possible values: <= 2147483647

    Number of failed item transfers.

  • running int32

    Possible values: <= 2147483647

    Number of running item transfers.

  • bpnLookups object

    Statistics of job execution.

  • completed int32

    Possible values: <= 2147483647

    Number of completed item transfers.

  • failed int32

    Possible values: <= 2147483647

    Number of failed item transfers.

  • running int32

    Possible values: <= 2147483647

    Number of running item transfers.

Loading...